Skip to content

Update README instructions for cloning and building #4679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README instructions for cloning and building #4679

wants to merge 1 commit into from

Conversation

@robertmcnees
Copy link

Minor changes to the README to include two small tasks to get the code to clone and compile locally.

git-lfs is required
Git Large File Storage is required to clone the project. Even with the command GIT_LFS_SKIP_SMUDGE=1 I still got the error:

git-lfs filter-process: git-lfs: command not found
fatal: the remote end hung up unexpectedly
warning: Clone succeeded, but checkout failed.

After a brew install git-lfs things worked fine. I verified after that the GIT_LFS_SKIP_SMUDGE=1 did reduce the disk size of the download. But git-lfs seems to be a requirement.

Run Docker Desktop
To build the project I needed a container runtime (i.e. Docker Desktop) running locally.

@robertmcnees
Update README instructions for cloning and building
fbc0bdb 
Git Large File Storage is required to clone the project.
To build the project a container runtime (i.e. Docker Desktop)
is required to be running locally.

Signed-off-by: Robert McNees <86265089+robertmcnees@users.noreply.github.com>
@ilayaperumalg ilayaperumalg added the documentation Improvements or additions to documentation label Oct 21, 2025
markpollack
markpollack reviewed Oct 22, 2025
View reviewed changes
README.md

- Ignore the large files (won't affect the spring-ai behaviour) : `GIT_LFS_SKIP_SMUDGE=1 git clone git@github.com:spring-projects/spring-ai.git`.
- Or install the [Git Large File Storage](https://git-lfs.com/) before cloning the repo.
- Install the [Git Large File Storage](https://git-lfs.com/) before cloning the repo.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I frankly don't even know this is needed. I never had an issue cloning (on ubuntu) and I others on the team on Mac don't have this large file support installed. Can you tell us what happens? I'd like to not have this dependency to clone of course ,but there seems to be a deeper issue here.

Thanks!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it's local to my machine. I pasted my experience below in detail. It's a small change so if it's not true for everyone feel free to close the PR.

@markpollack markpollack added this to the 1.1.0.RC1 milestone Oct 22, 2025
@robertmcnees
Copy link
Author

Additional context on my experience cloning the repository. I was using https, not ssh.

No git-lfs
No GIT_LFS_SKIP_SMUDGE

mcnees@mac temp % git clone https://github.com/spring-projects/spring-ai.git
Cloning into 'spring-ai'...
remote: Enumerating objects: 116717, done.
remote: Counting objects: 100% (360/360), done.
remote: Compressing objects: 100% (237/237), done.
remote: Total 116717 (delta 178), reused 137 (delta 107), pack-reused 116357 (from 3)
Receiving objects: 100% (116717/116717), 87.17 MiB | 34.32 MiB/s, done.
Resolving deltas: 100% (45643/45643), done.
git-lfs filter-process: git-lfs: command not found
fatal: the remote end hung up unexpectedly
warning: Clone succeeded, but checkout failed.
You can inspect what was checked out with 'git status'
and retry with 'git restore --source=HEAD :/'

No git-lfs
With GIT_LFS_SKIP_SMUDGE

mcnees@mac temp % GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/spring-projects/spring-ai.git
Cloning into 'spring-ai'...
remote: Enumerating objects: 116717, done.
remote: Counting objects: 100% (361/361), done.
remote: Compressing objects: 100% (244/244), done.
remote: Total 116717 (delta 177), reused 131 (delta 101), pack-reused 116356 (from 3)
Receiving objects: 100% (116717/116717), 87.17 MiB | 22.81 MiB/s, done.
Resolving deltas: 100% (45687/45687), done.
git-lfs filter-process: git-lfs: command not found
fatal: the remote end hung up unexpectedly
warning: Clone succeeded, but checkout failed.
You can inspect what was checked out with 'git status'
and retry with 'git restore --source=HEAD :/'

In both cases the folder only checked out a subset of files:
image

In both instances, this error message seems relevant:
git-lfs filter-process: git-lfs: command not found

Could that be because of .gitattributes?

Once I installed git-lfs things were smooth.

With git-lfs
No GIT_LFS_SKIP_SMUDGE

mcnees@mac temp % brew install git-lfs

mcnees@mac temp % git clone https://github.com/spring-projects/spring-ai.git
Cloning into 'spring-ai'...
remote: Enumerating objects: 116717, done.
remote: Counting objects: 100% (361/361), done.
remote: Compressing objects: 100% (244/244), done.
remote: Total 116717 (delta 177), reused 131 (delta 101), pack-reused 116356 (from 3)
Receiving objects: 100% (116717/116717), 87.17 MiB | 28.18 MiB/s, done.
Resolving deltas: 100% (45687/45687), done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@markpollack markpollack markpollack left review comments

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

1.1.0.RC1

Development

Successfully merging this pull request may close these issues.

3 participants

@robertmcnees @markpollack @ilayaperumalg